9244
85 
V současné době se snažím přenést existující API API na straně serveru z jeho stávajícího ručně zkopírovat a vložit dědický systém na lepší a spolehlivější systém. Čistý prototyp nelze použít, protože stav (proměnné) objektů musí být také zděděn a nesmí být přepsán v nadřazených objektech.
Takže přemýšlím o použití dobrého řešení od Johna Reisiga popsaného zde:
http://ejohn.org/blog/simple-javascript-inheritance/
což je pro můj případ skvělé.
Jedinou výzvou, které nyní čelím, je to, že většina rámců dokumentace nebude zpracovávat takto konstruované objekty (NEBO prostě nevím, jak jim to říct). Moje otázka tedy zní, jak mohu dokumentovat takovéto třídy:
namespace.ClassA = Class.extend ({
název : "",
init: funkce (jméno) {
this.name = name;
}
});
namespace.ClassB = ClassA.extend ({
sayName: function () {
console.log (this.name);
}
});
Dávám přednost JsDoc, ale nemohl jsem vymyslet způsob, jak tento druh tříd dokumentovat pomocí JsDoc. Také jsem zkusil NaturalDocs, který by fungoval, ale opravdu nechci, aby všechny tyto extra pythonové věci byly v procesu sestavení.
Myslím, že hlavní problémy, které mám, jsou s jmennými prostory
Například:
/ ** @memberof namespace ** /
namespace.ClassB = ClassA.extend (
/ ** @lends ClassB.prototype ** /
{
/ ** @constructs ** /
init: function () {
},
sayName: function () {
console.log (this.name);
}
});
nebude zahrnovat ani zobrazovat ClassB v oboru názvů "namespace"
2020-12-17 08:21:14 
Zjistěte, zda pro vás funguje následující. Všimněte si, že váš fragment kódu není sám o sobě platný JavaScript, protože jmenný prostor není nikde definován. V každém případě to jsdoc zpracuje. Co jsem musel udělat, bylo být více upovídaný, než bych byl jinak. Několik poznámek:
Můžete umístit doclet, který definuje ClassA, před řádek, který má namespace.ClassA.
Značka @lends vyžaduje úplnou cestu: / ** @lends namespace.ClassB.prototype * /
Tady je kód:
/ **
* @namespace namespace
* /
namespace.ClassA = Class.extend ({
název : "",
/ **
* @ konstruktor
* @memberof namespace
* @ jméno ClassA
* @param jméno Blah.
* /
init: funkce (jméno) {
this.name = name;
}
});
/ **
* @ konstruktor
* @memberof namespace
* @ jméno ClassB
* /
namespace.ClassB = ClassA.extend (/ ** @lends namespace.ClassB.prototype * / {
/ **
* @ metoda
* /
sayName: function () {
console.log (this.name);
}
});
|
Tvoje odpověď
StackExchange.ifUsing ("editor", function () {
StackExchange.using ("externalEditor", function () {
StackExchange.using ("snippets", function () {
StackExchange.snippets.init ();
});
});
}, „code-snippets“);
StackExchange.ready (funkce () {
var channelOptions = {
tagy: "" .split (""),
id: "1"
};
initTagRenderer ("". split (""), "" .split (""), channelOptions);
StackExchange.using ("externalEditor", function () {
// Po výstřižcích musíte vypálit editor, pokud jsou úryvky povoleny
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using ("snippets", function () {
createEditor ();
});
}
else {
createEditor ();
}
});
funkce createEditor () {
StackExchange.prepareEditor ({
useStacksEditor: false,
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by \ u003ca href = \" https: //imgur.com/ \ "\ u003e \ u003csvg class = \" svg-icon \ "width = \" 50 \ "height = \" 18 \ "viewBox = \ "0 0 50 18 \" fill = \ "none \" xmlns = \ "http: //www.w3.org/2000/svg \" \ u003e \ u003cpath d = \ "M46.1709 9.17788C46.1709 8.26454 46,2665 7,94324 47,1084 7,58816C47.4091 7,46349 47,7169 7,36433 48,0099 7,26993C48,9099 6,97977 49,672 6,73443 49,672 5,93063C49,672 5,22043 48,9832 4,61182 48,1414 4,61182C47,4335 4,61182 46,7256 4,91628 4,91650 4,91650 4,416 164 4,45 43,1481 6,59048V11.9512C43.1481 13,2535 43,6264 13,8962 44,6595 13,8962C45,6924 13,8962 46,1709 13,2535 46,1709 11,9512V9.17788Z \ "/ \ u003e \ u003cpath d = \" M32.492 10,1419432,144,14,144,14,144,44 41,5985 12,6954 41,5985 10,1419V6,59049C41,5985 5,28821 41,1394 4,66232 40,1061 4,66232C39,0732 4,66232 38,5948 5,2881 38,5948 6,59049V9,60062C38,5948 10,8521 38,2696 11,5455 37,0451 11,5455C35,535 521 35,4954 960062V6.59049C35.4954 5,28821 35,0173 4,66232 34,0034 4,66232C32,9703 4,6632 32,492 5,28821 32,492 6,59049V10.1419Z \ "/ \ u003e \ u003cpath fill-rule = \" evenodd \ "clip-rule = \" evenodd \ " = \ "M25.6622 17.6335C27.8049 17.6335 29.3739 16.9402 30.2537 15.6379C30.8468 14.7755 30.9615 13.5579 30.9615 11.9512V6.59049C30.9615 5.28821 30.4833 4.66231 29.4502 4.66231C28.9913 4.66231 28.49.549.549.549.549.54.4550 0,1369 4,56087 21,0134 6,57349 21,0134 9,27932C21.0134 11,9852 23,003 13,913 25,3754 13,913C26,5612 13,913 27,4607 13,4902 28,1109 12,6616C28.1109 12,7229 28,1161 12,77,712,122,122,121,121 15.2321 24.1352 14,9821 23,5661 14,7787 C23,176 14,6393 22,8472 14,5218 22,5437 14,5218C21,7977 14,5218 21,2429 15,0123 21,2429 15,6878721,2429 16,7375 22,9072 17,6335 25,6622 17,6335ZM24,1317 7,287 7,247 26,2417 26,2817 27.2119 7,09766 28,0918 7,94324 28,0918 9,27932C28.0918 10,6321 27,2311 11,5116 26,1024 11,5116C24,9737 11,5116 24,1317 10,6491 24,1317 9,27323 \ 19,8079 13,2535 19,8079 11,9512V8,12928C19,8079 5,82936 18,4879 4,62866 16,4027 4,62866C15,1594 4,62866 14,279 4,98375 13,3609 5,88013C12,653 5,05154 11,6581 4,62866 10,3573 4,62866C9,3433 6,48,67 7,32 6,47,32 4,46,67 7,32 6,4 7,32 6 4,432 6,47 7,32 6,4 7,32 4,4 6,32 6,4 5.00066 5,28821 500066 6,59049V11,9512C5,00066 13,2535 5,47873 13,8962 6,51203 13,8962C7,54479 13,8962 8,0232 13,2535 8,0232 11,9512V8,90741C8,0232 7,58817 8,44431 6,91179 9,53458 6,91179C10,5104 8,10118,810 11,88 C13.4375 13.8962 13,9157 13,2535 13,9157 11,9512V8,90741C13,9157 7,58817 14,3365 6,91179 15,4269 6,91179C16.4027 6,91179 16,8045 7,58817 16,8045 8,94108V11,9512Z \ "/ \ u003e \ u003cpath d = \ "M3.31675 6.59049C3.31675 5.28821 2.83866 4.66232 1.82471 4.66232C0.791758 4.66232 0.3133545,28821 0,313354 6,59049V11,9512C0,313354 13,2535 0,791758 13,8962 1,82471 13,8962C2.85798 13,8962 3,31675 13,2535 3,31675 11,9512V6,59049Z \ "/ \ u003e \ u003cpath d = \" M1.87209 0,429 0,00112 0,0029000 3,57676 1,87209 3,57676C2.90056 3,57676 3,7234 2,87869 3,7234 1,98861C3,7234 1,1159 2,90056 0,400291 1,87209 0,400291Z \ "fill = \" # 1BB76E \ "/ \ u003e \ u003c / svg \ u003e \ u003c
contentPolicyHtml: "Uživatelské příspěvky jsou licencovány pod \ u003ca href = \" https: //stackoverflow.com/help/licensing \ "\ u003ecc by-sa \ u003c / a \ u003e \ u003ca href = \" https://stackoverflow.com / legal / content-policy \ "\ u003e (obsahové zásady) \ u003c / a \ u003e",
allowUrls: true
},
onDemand: pravda,
discardSelector: ".discard-answer"
, okamžitěShowMarkdownHelp: true, enableTables: true, enableSnippets: true
});
}
});
Děkujeme, že jste přispěli odpovědí na Stack Overflow!
Nezapomeňte na otázku odpovědět. Uveďte podrobnosti a sdílejte svůj výzkum!
Ale vyhnout se ...
Žádáme o pomoc, vysvětlení nebo reagujeme na jiné odpovědi.
Dělat prohlášení na základě názoru; podpořte je referencemi nebo osobními zkušenostmi.
Chcete-li se dozvědět více, přečtěte si naše tipy na psaní skvělých odpovědí.
Koncept uložen
Koncept zahozen
Zaregistrujte se nebo se přihlaste
StackExchange.ready (funkce () {
StackExchange.helpers.onClickDraftSave ('# login-link');
});
Zaregistrujte se pomocí Google
Zaregistrujte se pomocí Facebooku
Zaregistrujte se pomocí e-mailu a hesla
Předložit
Zveřejněte jako host
název
E-mailem
Povinné, ale nikdy zobrazené
StackExchange.ready (
funkce () {
StackExchange.openid.initPostLogin ('. New-post-login', 'https% 3a% 2f% 2fstackoverflow.com% 2fquestions% 2f22246014% 2fdocumenting-complex-javascript-objects-with-custom-inheritance-system% 23new-answer' , 'question_page');
}
);
Zveřejněte jako host
název
E-mailem
Povinné, ale nikdy zobrazené
Zveřejněte svou odpověď
Vyřadit
Kliknutím na „Odeslat odpověď“ vyjadřujete souhlas s našimi podmínkami služby, zásadami ochrany osobních údajů a zásadami používání souborů cookie
Toto není odpověď, kterou hledáte? Přečtěte si další otázky týkající se značek dokumentace javascript ecmascript-5 jsdoc jsdoc3 nebo položte vlastní otázku.